home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Just Call Me Internet
/
Just Call Me Internet.iso
/
prog
/
atari
/
m2
/
cat3src
/
cat
/
doku
/
itkdef.txt
< prev
next >
Wrap
Text File
|
1997-10-26
|
7KB
|
161 lines
Gruppe: TAUSCHBAU
ID: A50369@K2
Wg.: ITK, neue Version
Von: Gereon Steffens @ K2 (Do, 20.07.95 17:33)
MId: 199507201733.a50369@k2.maus.de
Seit eben gerade gibt's in K2 eine neue Version des ITK zu bewundern (Danke,
Marcus!!). Hier die Doku dazu:
ITK-Zeilen:
ID des Kommandos *
N Name des Kommandos *
A Aufzhlung der Werte eines Aufzhlungstyps
B Beschreibung der Werte eines Aufzhlungstyps
C Konstante Teile der Syntax *
D Defaultwert fr ein Feld *
F Datentyp eines Feldes *
H Ausfhrliche Beschreibung des Kommandos *
K Kurze Beschreibung eines Parameters *
L Ausfhrliche Beschreibung eines Parameters *
T Art des Kommandos *
V Version des Kommandos *
# ist eine ganze Zahl, die dieses Kommando eindeutig identifiziert.
N ist eine nicht zu lange Bezeichnung fr das Kommando; sie knnte z.B.
als Auswahl in einem Men verwendet werden.
C beschreibt konstante Teile der Syntax.
H ist eine ausfhrlichere Beschreibung des Kommandos; das Frontend knnte sie
als Online-Hilfe im Men fr das entsprechende Kommando zur Verfgung
stellen.
V enthlt eine ganze Zahl, die als Versionsnummer dieses Kommandos dient.
ndert sich die Syntax oder die Bedeutung, so ist diese Nummer zu erhhen.
T gibt die Art des Kommandos an:
TK besagt, da es sich um ein Kommando handelt, das der Anwender per
Konfiguration festlegen knnen sollte und welches dann automatisch
immer wieder benutzt wird.
TE kennzeichnet ein Kommando, das pro Tausch manuell aktiviert werden
knnen sollte, aber nur einmal im Infile auftauchen sollte;
TB schlielich bedeutet, da der User mehrere dieser Kommandos pro
Tausch absetzen kann, diese aber vom Frontend nur so hufig abgesetzt
werden, wie der User sie explizit eingibt.
Fc gibt den Datentyp eines Parameters an (s. unten)
Ks gibt eine kurze Bezeichnung eines Parameters; das Frontend kann sie
benutzen, um im Dialog das entsprechende Feld zu beschriften.
Ls gibt eine ausfhrlichere Beschreibung des Parameters. Das Frontend knnte
diese als Onlinehilfe zu dem einzelnen Feld anbieten.
Ds gibt einen Defaultwert fr den Parameter vor; die Syntax ist die, die auch
im Infile fr diesen Parameter zu verwenden ist.
As[:s...]
Gibt die Infile-Syntax fr einen Wert eines Aufzhlungstyps an.
Jeder Wert kann mehrere Zustnde annehmen. Die Syntax verschiedener
Zustnde wird dabei durch Doppelpunkte getrennt. Beispiel:
A+:
, d.h. es existieren zwei Zustnde. Der erste wird durch '+' angegeben,
der zweite durch einen Leerstring. Bei Werten mit zwei Zustnden sollte
die Beschreibung derart gewhlt werden, da das Frontend den ersten
der Zustnde durch 'markiert', den zweiten durch 'nicht markiert' in
einer Dialogbox symbolisieren kann. Bei Werten mit drei Zustnden
sollte sie so gewhlt werden, da der erste durch 'positiv markiert',
der zweite durch 'negativ markiert' und der dritte durch 'nicht markiert'
symbolisiert werden kann.
Diese Angabe bezieht sich auf die Syntax und braucht also dem User
nicht angezeigt zu werden.
Bs bezeichnet einen Wert eines Aufzhlungstyps.
Die Unterteilung von Aufzhlungstypen erfolgt zweidimensional ("Werte
des Aufzhlungstyps" X "Zustnde eines Wertes"), da dies der Praxis
am nchsten kommt. Beschreibungen werden nur fr *Werte* angegeben,
whrend die verschiedenen Zustnde eines Wertes nur durch unterschiedliche
Markierungen an der jeweiligen einzigen Beschreibung dargestellt werden.
brigens existiert die Option "Set Of" nur entlang der ersten Dimension.
Diese Aspekte sind beim Entwurf von Kommandobeschreibungen zu
bercksichtigen. Es ist von Fall zu Fall zu entscheiden, ob es intuitiver
ist, die Werte entlang der ersten, der zweiten oder beider Dimensionen
anzuordnen.
Beispielsweise ist es sinnvoll, eine Auswahl im Sinne von "Ein/Aus"
(z.B. "Anfordern/Nicht Anfordern") entlang der zweiten Dimension anzu-
ordnen: es gengt vollkommen, wenn der Anwender ein Feld "Anfordern"
erhlt, das er aktivieren kann oder nicht.
Hingegen ist es bei einer Auswahl zwischen zwei nicht direkt entgegen-
gesetzten Mglichkeiten ("Neue anfordern/Alle anfordern") sinnvoll,
dies entlang der ersten Dimension zu tun, um zwei verschiedene Dialog-
felder mit jeweils eigenen Beschreibungen zu erzeugen.
Die generelle Struktur eines ITK-Eintrags ist somit wie folgt:
#<Kommando-Nummer>
Diese Zeile leitet ein neues Kommando ein. Alle folgenden Zeilen bis zum
Ende oder bis zur nchsten #-Zeile beziehen sich auf dieses Kommando.
N<Kommando-Name>
H<Kommando-Beschreibung>
T<Kommando-Art>
V<Kommando-Version>
Auf diesen mehr oder weniger konstanten Block folgen dann ein oder mehrere
syntaxbeschreibende Blcke. Ein syntaxbeschreibender Block wird eingeleitet
durch eine C- oder eine F-Zeile. Wird er durch eine C-Zeile eingeleitet,
so produziert er einen konstanten String und besteht nur aus dieser C-Zeile.
Ein Block, der durch eine F-Zeile eingeleitet wird, beschreibt einen vom
User einzugebenden Parameter.
F<Datentyp>
Diese Zeile leitet einen neuen Parameter ein. Alle folgenden Zeilen bis
zum Ende des Kommandos oder bis zur nchsten C- oder F-Zeile beziehen sich
auf diesen Parameter.
D<Defaultwert>
K<kurze Beschreibung>
L<lange Beschreibung>
<ggf. noch A- und B-Zeilen, immer paarweise, immer A-Zeile zuerst>
Die Produkte aller C/F-Blcke, in der gegebenen Reihenfolge konkateniert,
ergeben das Infile-Kommando.
H und L drfen jeweils mehrfach auftreten. Ein Blank zu Beginn einer Zeile
weist das Frontend an, diese Zeile weder neu umzubrechen noch sie zwecks
neuen Umbruchs an die vorhergehende Zeile anzuhngen.
Als Datentypen c stehen zur Verfgung:
Darstellung im Infile
A - Aufzhlungstyp wie in A-Zeilen angegeben
M - Set of Aufzhlung;
es gilt alles wie fr A,
nur da das Frontend erlauben
mu, mehrere Werte gleichzeitig
zu aktivieren.
D - Datum JJJJMMTTHHMM[SS]
d - Datum TT[.MM[.JJJJ]]
Sn - String der Lnge n wie eingegeben
Pn - Pawort der Lnge n wie eingegeben
(wird ggf. nicht angezeigt)
pn - neues Pawort der Lnge n wie eingegeben
(Frontend kann ggf. zweimal
fragen)
U - Username wie eingegeben
I - ganze Zahl, 2 Byte dezimal, Ascii, mit
Vorzeichen, auch wenn positiv
Im,n - ganze Zahl aus dem Intervall dezimal, Ascii, mit
[m;n]. Vorzeichen, auch wenn positiv
G - Gruppenname im Klartext
g - Name einer Gruppe, in der im Klartext
User Chef ist
Ein 'o' hinter dem Datentyp bedeutet, da in das Feld keine Daten eingegeben
werden mssen. Im Infile ist dann ein Leerstring einzutragen.
Gereon